<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libxlsxwriter: lxw_workbook_options Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">libxlsxwriter
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">lxw_workbook_options Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Workbook options.  
 <a href="structlxw__workbook__options.html#details">More...</a></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Optional parameters when creating a new Workbook object via <a class="el" href="workbook_8h.html#a8ca9bd8c30c618b81ca6180f78b03323" title="Create a new workbook object, and set the workbook options.">workbook_new_opt()</a>.</p>
<p>The following properties are supported:</p>
<ul>
<li><code>constant_memory</code>: This option reduces the amount of data stored in memory so that large files can be written efficiently. This option is off by default. See the note below for limitations when this mode is on.</li>
<li><code>tmpdir</code>: libxlsxwriter stores workbook data in temporary files prior to assembling the final XLSX file. The temporary files are created in the system's temp directory. If the default temporary directory isn't accessible to your application, or doesn't contain enough space, you can specify an alternative location using the <code>tmpdir</code> option.</li>
<li><code>use_zip64</code>: Make the zip library use ZIP64 extensions when writing very large xlsx files to allow the zip container, or individual XML files within it, to be greater than 4 GB. See <a href="https://en.wikipedia.org/wiki/Zip_(file_format)#ZIP64">ZIP64 on Wikipedia</a> for more information. This option is off by default.</li>
</ul>
<dl class="section note"><dt>Note</dt><dd>In <code>constant_memory</code> mode a row of data is written and then discarded when a cell in a new row is added via one of the <code>worksheet_write_*()</code> functions. Therefore, once this option is active, data should be written in sequential row order. For this reason the <code><a class="el" href="worksheet_8h.html#ad5a2a09ec65c0f286b756235c7327225" title="Merge a range of cells.">worksheet_merge_range()</a></code> doesn't work in this mode. See also <a class="el" href="working_with_memory.html#ww_mem_constant">Constant Memory Mode</a>. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="constant_memory_8c-example.html#_a0">constant_memory.c</a>.</dd>
</dl>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aa03636857813ca881bdd09e07bcbe738"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__workbook__options.html#aa03636857813ca881bdd09e07bcbe738">constant_memory</a></td></tr>
<tr class="separator:aa03636857813ca881bdd09e07bcbe738"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a79cfd2824acc5a438f37d4f79da325"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__workbook__options.html#a6a79cfd2824acc5a438f37d4f79da325">tmpdir</a></td></tr>
<tr class="separator:a6a79cfd2824acc5a438f37d4f79da325"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeff094d01eb078b6621bd3ebbd6e326b"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__workbook__options.html#aeff094d01eb078b6621bd3ebbd6e326b">use_zip64</a></td></tr>
<tr class="separator:aeff094d01eb078b6621bd3ebbd6e326b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="aa03636857813ca881bdd09e07bcbe738"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa03636857813ca881bdd09e07bcbe738">&#9670;&nbsp;</a></span>constant_memory</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t lxw_workbook_options::constant_memory</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Optimize the workbook to use constant memory for worksheets. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="constant_memory_8c-example.html#a1">constant_memory.c</a>.</dd>
</dl>

</div>
</div>
<a id="a6a79cfd2824acc5a438f37d4f79da325"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a79cfd2824acc5a438f37d4f79da325">&#9670;&nbsp;</a></span>tmpdir</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* lxw_workbook_options::tmpdir</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Directory to use for the temporary files created by libxlsxwriter. </p>

</div>
</div>
<a id="aeff094d01eb078b6621bd3ebbd6e326b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeff094d01eb078b6621bd3ebbd6e326b">&#9670;&nbsp;</a></span>use_zip64</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t lxw_workbook_options::use_zip64</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Allow ZIP64 extensions when creating the xlsx file zip container. </p>

</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.20-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Copyright 2014-2020 John McNamara.
Generated by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
</small></address>
</body>
</html>
